Range(cloud dedicated)

Function

This API is used to get parameter range for Record > Playback Page page.

Request Message

None.

Sample:

POST API/Playback/PlaybackPage/Range HTTP/1.1
{
	"version": "1.0"
}

Response Message

Parameter Description

Table 1

ParameterRangeTypeDescription
NormalJson objectShow as followTable2
PictureJson objectShow as followTable2
type_enum_arr"nor",
"md",
"io",
"od",
"manual",
"netbreak",
"pid",
"lcd",
"intrusion",
"enter",
"exit",
"sod",
"pdvd",
"fd",
"cc",
"attr",
"cd",
qd",
"lpd",
"pedestrian",
"vehicle",
"nonvehicle",
"rsd"
Json object

Table 2

ParameterRangeTypeDescription
display_mode“Treelike”,
“Checkbox”
intUI display type
default_sort_of_resultsintSearch information in default or reverse order
itemsintShow as followTable3
similarity_faceintControl the range and default value of the IE playback Face Detection similarity input box
similarity_customerintControl the Fault-tolerant input field and the default value of the IE playback License Plate
similarity_licenseintThe range and default value of the similarity input box controlling the IE playback of Repeat customer
recordColorArrArraySearch video color alerts。Show as followTable7.Note: cloud dedicated
record_type_arrArrayShow as followTable8.Note: cloud dedicated
type_filter_arrArrayIntelligent human model color display。Show as followTable9.Note: cloud dedicated

Table 3

ParameterRangeTypeDescription
record_typeJson objectlayback type Show as followTable4
stream_mode“Mainstream”,
“Substream”
stringPrimary substream type (Normal only has this field)

Table 4

ParameterRangeTypeDescription
normalboolcommon
manualboolmanual operation
alarmJson objectAlarm
Show as followTable5 (IPC only)
smartJson objectIntelligence
Show as followTable6 (for IPC)
HumanboolAI Humanoid (NVR only)
VehicleboolAI models (NVR only)
IOboolIo Alarm Video Type (NVR special)
motionboolMotion Alarm Video Type (NVR only)
PIRboolPir(NVR only)
SoundboolAudible alarm (NVR only)
occulusionboolLens Occlusion (NVR only)
IntelligentboolIntelligent Analytics (NVR only)
PIDboolAI Perimeter Intrusion (NVR only)
LCDboolAI crossing Detection (NVR only)
faceAttrboolFace Properties (NVR only)

Table 5

ParameterRangeTypeDescription
IOJson objectIO alarm video type
motionJson objectMotion Alarm Video Type
PIRJson objectPir
SoundJson objectAudible alarm
NetbreakJson objectOff-grid recording

Table 6

ParameterRangeTypeDescription
PIDbool
LCDbool
SODbool
PDbool
FDbool
CCbool
intrusionbool
regionEntrancebool
regionExitingbool

Table 7

ParameterRangeTypeDescription
commonintVideo common color reminders
eventintVideo event color reminders
colorStringSearch for smart types to display colors

Table 8

ParameterRangeTypeDescription
type"common",
"event"",
"default",
"pedestrian",
"vehicle",
"nonvehicle"
StringIntelligent support type
colorStringSearch for smart types to display colors
childrenArraychild node:Show as followTable9

Table 9

ParameterRangeTypeDescription
type"normal",
"md",
"io",
"netbreak",
"pdvd",
"lpd",
"fd",
"intrusion",
"enter",
"exit",
"others
StringIntelligent support type
colorStringSearch for smart types to display colors
expandArrayWhether the child node can be expanded and whether the video type used for web display can be expanded
childrenArraychild node:Show as followTable10

Table 10

ParameterRangeTypeDescription
type"nor",
"lcd",
"cc",
"sod",
"rsd",
"qd",
"cd",
"attr",
"od",
"pedestrian",
"vehicle",
"nonvehicle"
StringIntelligent support type
colorStringSearch for smart types to display colors

Tips

The response message of the Range request may not contain all the fields in the above table, and the fields not included indicate that the device does not support this parameter configuration.

Sample

HTTP/1.1 200 OK
Content-Type: application/json
{
    "result": "success",
    "data": {
        "Picture": {
            "type": "object",
            "items": {"record_type": {
                "type": "object",
                "items": {
                    "normal": {"type": "bool"},
                    "event": {
                        "type": "object",
                        "items": {
                            "IO": {"type": "bool"},
                            "PIR": {"type": "bool"},
                            "motion": {"type": "bool"}
                        }
                    }
                }
            }},
            "display_mode": "Treelike"
        },
        "Normal": {
            "type": "object",
            "items": {"record_type": {
                "type": "object",
                "items": {
                    "normal": {"type": "bool"},
                    "event": {
                        "type": "object",
                        "items": {
                            "IO": {"type": "bool"},
                            "PIR": {"type": "bool"},
                            "Netbreak": {"type": "bool"},
                            "motion": {"type": "bool"},
                            "occulusion": {"type": "bool"}
                        }
                    },
                    "ai": {
                        "type": "object",
                        "items": {
                            "lcd": {"type": "bool"},
                            "sod": {"type": "bool"},
                            "pd&vd": {"type": "bool"},
                            "fd": {"type": "bool"},
                            "cc": {"type": "bool"},
                            "cd": {"type": "bool"},
                            "qd": {"type": "bool"},
                            "lpd": {"type": "bool"},
                            "intrusion": {"type": "bool"},
                            "regionEntrance": {"type": "bool"},
                            "regionExiting": {"type": "bool"},
                            "faceAttr": {"type": "bool"},
                            "rsd": {"type": "bool"},
                            "Pedestrian": {"type": "bool"},
                            "MotorVehicle": {"type": "bool"},
                            "Non-motorized Vehicle": {"type": "bool"}
                        }
                    }
                }
            }},
            "display_mode": "Treelike",
            "recordColorArr": [
                {
                    "common": 0,
                    "color": "#48C840"
                },
                {
                    "event": 0,
                    "color": "#30A0F8"
                }
            ],
            "record_type_arr": [
                {
                    "type": "common",
                    "color": "#48C840",
                    "children": [
                        {
                            "type": "normal",
                            "color": "#48C840",
                            "expand": false,
                            "children": [{
                                "type": "nor",
                                "color": "#48C840"
                            }]
                        },
                        {
                            "type": "md",
                            "color": "#48C840"
                        },
                        {
                            "type": "io",
                            "color": "#48C840"
                        },
                        {
                            "type": "netbreak",
                            "color": "#48C840"
                        }
                    ]
                },
                {
                    "type": "event",
                    "color": "#30A0F8",
                    "children": [
                        {
                            "type": "pdvd",
                            "color": "#30A0F8"
                        },
                        {
                            "type": "lpd",
                            "color": "#30A0F8"
                        },
                        {
                            "type": "fd",
                            "color": "#30A0F8"
                        },
                        {
                            "type": "intrusion",
                            "color": "#30A0F8"
                        },
                        {
                            "type": "enter",
                            "color": "#30A0F8"
                        },
                        {
                            "type": "exit",
                            "color": "#30A0F8"
                        },
                        {
                            "type": "others",
                            "color": "#30A0F8",
                            "expand": false,
                            "children": [
                                {
                                    "type": "lcd",
                                    "color": "#30A0F8"
                                },
                                {
                                    "type": "cc",
                                    "color": "#30A0F8"
                                },
                                {
                                    "type": "sod",
                                    "color": "#30A0F8"
                                },
                                {
                                    "type": "rsd",
                                    "color": "#30A0F8"
                                },
                                {
                                    "type": "qd",
                                    "color": "#30A0F8"
                                },
                                {
                                    "type": "cd",
                                    "color": "#30A0F8"
                                },
                                {
                                    "type": "attr",
                                    "color": "#30A0F8"
                                },
                                {
                                    "type": "od",
                                    "color": "#30A0F8"
                                },
                                {
                                    "type": "pedestrian",
                                    "color": "#30A0F8"
                                },
                                {
                                    "type": "vehicle",
                                    "color": "#30A0F8"
                                },
                                {
                                    "type": "nonvehicle",
                                    "color": "#30A0F8"
                                }
                            ]
                        }
                    ]
                }
            ],
            "type_filter_arr": [
                {
                    "type": ["default"],
                    "color": "#48C840"
                },
                {
                    "type": ["pedestrian"],
                    "color": "#30A0F8"
                },
                {
                    "type": [
                        "vehicle",
                        "nonvehicle"
                    ],
                    "color": "#30A0F8"
                }
            ]
        },
        "type_enum_arr": [
            "nor",
            "md",
            "io",
            "od",
            "manual",
            "netbreak",
            "pid",
            "lcd",
            "intrusion",
            "enter",
            "exit",
            "sod",
            "pdvd",
            "fd",
            "cc",
            "attr",
            "cd",
            "qd",
            "lpd",
            "pedestrian",
            "vehicle",
            "nonvehicle",
            "rsd"
        ]
}
}

Error Code

See Response Messages Body and Common error_code for more information.